Fix doc comments in Process.fs#2885
Open
Numpsy wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates XML doc comments in Fake.Core.Process’s Shell API to match the actual optional parameter name (dir) and fixes a small grammar issue in the summary text.
Changes:
- Update
<param>name fromdirectorytodirforShell.ExecandShell.AsyncExec. - Fix “it’s completion” → “its completion” in the
Shell.Execsummary.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
933
to
934
| /// <param name="cmd">The command which should be run in elevated context.</param> | ||
| /// <param name="args">The process arguments (optional).</param> |
Comment on lines
943
to
944
| /// <param name="cmd">The command which should be run in elevated context.</param> | ||
| /// <param name="args">The process arguments (optional).</param> |
The Exec functions have a parameter called 'dir' but the doc comments have 'directory', so this just makes them consistent
Collaborator
|
Are there any relevant comments from Copilot? |
Contributor
Author
|
I wasn't looking at anything other than the param names before, but looking at the code now the 'async' function doesn't look very async? (actually it looks the same as the implementation of the not-async version) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Exec functions have a parameter called 'dir' but the doc comments have 'directory', so this just makes them consistent
(Just noticed a warning in Rider when looking at #2880 and though they should be consistent)